Repository navigation
build(release): tools/release_notes.py for GitHub release text - #391
Merged
Merged
Conversation
GitHub shows every newline in a release description as a line break, so the wrapped notes pages broke mid-sentence on every release page. The script joins wrapped paragraph, list and quote lines and makes relative links absolute at the tag; the release checklist names it. Related to #390
Owner
Author
|
Merged into |
This was referenced Nov 4, 2026
Closed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #390.
GitHub shows every newline in a release description as a line break. Our notes pages are wrapped at about 78 columns, so every GitHub release so far showed its sentences broken mid-line. The release step only made the links absolute.
Changes
tools/release_notes.py vX.Y.Z: prints the GitHub release text fordocs/releases/vX.Y.Z.md.tree/for a link that ends in/), and errors on a link that points outside the repo.--self-testruns 11 built-in samples.CLAUDE.md: release checklist step 5 now publishes and edits the release from the script, and says why.docs/releases/README.md: one sentence pointing to the script.README.md: not changed. This is a release tool, not a reader-facing feature.Already done outside this PR
I rewrote the descriptions of all six releases, v0.1.0–v0.5.0, the same way:
<br>count is now 0 on each, with the tables and the v0.4.0 quote intact.>markers of joined quote lines.Tested
python3 tools/release_notes.py --self-testgives OK (11 samples). It caught a bug where a blank>line was merged into the next quote line, which is now fixed. No published release has a blank quote line.tools/release_notes.py v0.5.0matches the published description byte for byte.tree/folder links.check_links.py CLAUDE.md docs/releases/README.mdpasses, andgen_index.py --checkreports the index up to date.